Add rotation to Gaussian beam initialization #4767
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
aeriforme
changed the title
aeriforme
added
the
component: initialization
for more information, see https://pre-commit.ci
RemiLehe
reviewed
Sep 19, 2024
| @@ -951,6 +951,17 @@ Particle initialization | |||
|
|
|||
| \sigma_{x,y}(z) &= \sigma^*_{x,y} \sqrt{1 + \left( \frac{z - z^*}{\beta^*_{x,y}} \right)^2} | |||
|
|
|||
| * ``<species_name>.do_rotation`` (`bool`, optional) the beam is rotated around its centroid. | |||
There was a problem hiding this comment.
Could we change the user-input name, to make it clear that this argument is specific to the "gaussian_beam" initialization?
Suggested change
| * ``<species_name>.do_rotation`` (`bool`, optional) the beam is rotated around its centroid. | |
| * ``<species_name>.do_gaussian_beam_rotation`` (`bool`, optional) the beam is rotated around its centroid. |
There was a problem hiding this comment.
In the text, could you also add that this can be used e.g. to initialize beams that are crossing at an angle.
RemiLehe
reviewed
Sep 19, 2024
| @@ -951,6 +951,17 @@ Particle initialization | |||
|
|
|||
| \sigma_{x,y}(z) &= \sigma^*_{x,y} \sqrt{1 + \left( \frac{z - z^*}{\beta^*_{x,y}} \right)^2} | |||
|
|
|||
| * ``<species_name>.do_rotation`` (`bool`, optional) the beam is rotated around its centroid. | |||
|
|
|||
| If ``do_rotation = 1`` then the user needs to specify: | |||
There was a problem hiding this comment.
Suggested change
| If ``do_rotation = 1`` then the user needs to specify: | |
| If ``do_gaussian_beam_rotation = 1`` then the user needs to specify: |
RemiLehe
reviewed
Sep 19, 2024
|
|
||
| If ``do_rotation = 1`` then the user needs to specify: | ||
|
|
||
| * ``<species_name>.rotation_axis``: (list of 3 `doubles`) axis around which the rotation takes place |
There was a problem hiding this comment.
Suggested change
| * ``<species_name>.rotation_axis``: (list of 3 `doubles`) axis around which the rotation takes place | |
| * ``<species_name>.gaussian_beam_rotation_axis``: (list of 3 `doubles`) axis around which the rotation takes place |
RemiLehe
reviewed
Sep 19, 2024
|
|
||
| * ``<species_name>.rotation_axis``: (list of 3 `doubles`) axis around which the rotation takes place | ||
|
|
||
| * ``<species_name>.rotation_angle``: (`double`) angle of rotation around the specified axis, in radians. |
There was a problem hiding this comment.
Suggested change
| * ``<species_name>.rotation_angle``: (`double`) angle of rotation around the specified axis, in radians. | |
| * ``<species_name>.gaussian_beam_rotation_angle``: (`double`) angle of rotation around the specified axis, in radians. |
RemiLehe
reviewed
Sep 19, 2024
|
|
||
|
|
||
| Note that the other beam parameters (e.g. ``<species_name>.x/y/z_rms``, etc.) are used in the initialization process `before` performing the rotation. | ||
| Therefore, the user should define the beam size, cuts, and focal distance for the beam pre-rotatation, hence aligned to the Cartesian axes. |
There was a problem hiding this comment.
Suggested change
| Therefore, the user should define the beam size, cuts, and focal distance for the beam pre-rotatation, hence aligned to the Cartesian axes. | |
| Therefore, the user should define the beam size, cuts, and focal distance for the beam pre-rotation, hence aligned to the Cartesian axes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the option to rotate in space a species initialized as a Gaussian beam.
The rotation is performed around a user-defined axis by a user-defined angle.